home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 …ember: Reference Library / Apple Developer Reference Library (December 1999) (Disk 1).iso / pc / technical documentation / develop / develop issue 28 / develop issue 28 code / macapp debugging / twistdownlists / uprogressindicators.h < prev    next >
Encoding:
Text File  |  1996-07-15  |  8.5 KB  |  276 lines
  1. //----------------------------------------------------------------------------------------
  2. // UProgressIndicators.h
  3. // ETO20 MacApp 3.3.1, MPW 3.4.1
  4. // Copyright ©1995-1996 Conrad Kopala
  5. // Twist Down Lists version 2.0a0 7/15/96
  6. //Reference: A Reassuring Progress Indicator for MacApp by James Plamodon
  7. //FrameWorks Volume 5, Number 3, June 1991, page 46
  8. //----------------------------------------------------------------------------------------
  9. /*
  10. Instructions for use of TProgressBarIndicator
  11.  
  12. Add the following fields to the TYourObject that will be using the TProgressBarIndicator;
  13. TProgressBarIndicator* fProgressBarIndicator;
  14. long fUpdateAmount;
  15. long fProgressUpdateCounter;
  16.  
  17. In TYourObject::TYourObject() initialze them as follows:
  18. fProgressBarIndicator = NULL;
  19. fUpdateAmount = 0;
  20. fProgressUpdateCounter = 0;
  21.  
  22. In the method of TYourObject that uses TProgressBarIndicator insert the following code:
  23.  
  24.     CStr255 itsOperationString;
  25.     GetIndString(itsOperationString, kProgressIndicatorOperationStrings, 3);
  26.  
  27.     CStr255 itsSubjectString = fVolumeName;
  28.     fProgressBarIndicator = NewProgressBarIndicator(itsOperationString, itsSubjectString);
  29.  
  30.     this -> AddDependent(fProgressBarIndicator);
  31.     fProgressBarIndicator -> PrepareToStart(TRUE);
  32.  
  33.     long barLength = fProgressBarIndicator -> GetBarLength();
  34.  
  35. //The default value for fUpdateAmount is set to 1.                                
  36. //Unfortunately, if there are a lot of items to read and the progress bar is updated each time 
  37. //an item is read, it takes a long time to populate the list. With the following if statement,
  38. //the update amount is adjusted so that the progress bar is updated only when enough
  39. //progress has been made to update it by at least one pixel. This noticibly speeds things up. 
  40. //Comment out the following if statement and see for yourself. 
  41.  
  42.     if (fNumberOfItemsToLoad > barLength)
  43.         {
  44.             long updateAmount = fNumberOfItemsToLoad/barLength;    
  45.             this -> SetUpdateAmountTo(updateAmount);    
  46.         }
  47.     
  48.     progressUpdateCounter = 0;
  49.  
  50.     fProgressBarIndicator -> Start(fNumberOfItemsToLoad);
  51.  
  52.     You are now ready to use fProgressBarIndicator.
  53.     
  54. In the loop which does whatever is being done insert the following code:
  55.  
  56. do 
  57. {    
  58.         ++fProgressUpdateCounter;
  59.         if (fProgressUpdateCounter >= fUpdateAmount)
  60.             {
  61.                 fProgressUpdateCounter = 0;
  62.                 this -> Changed(mUpdateProgressBar, this);
  63.                 this -> SetChangeCount(0);    //If this refers to a TDocument, changed sets fChangeCount to 
  64.                                                                         //a positive value which will result in an attempt to save the 
  65.                                                                         //document when it is closed and if you don't want that, 
  66.                                                                         //set fChangecount to zero here. Or, override TDocument::Changed
  67.                                                                         //and don't call the inherited method.
  68.             }
  69.  
  70. } 
  71. while (fProgressBarIndicator -> IsStopped() == FALSE);
  72.  
  73. Whe you're done with fProgressBarIndicator, get rid of it:
  74.     if (fProgressBarIndicator != NULL)
  75.             {
  76.                 fProgressBarIndicator -> Stop();
  77.                 this -> RemoveDependent(fProgressBarIndicator);
  78.                 fProgressBarIndicator = (TProgressBarIndicator*)FreeIfObject(fProgressBarIndicator);
  79.             }        
  80. */
  81.  
  82.  
  83. #ifndef __UPROGRESSINDICATORS__
  84. #define __UPROGRESSINDICATORS__
  85.  
  86. //MacApp stuff
  87. /*
  88. #ifndef __UOBJECT__
  89. #include "UObject.h"
  90. #endif
  91. */
  92. #ifndef __UCONTROL__
  93. #include "UControl.h"
  94. #endif
  95.  
  96. #ifndef __UDIALOG__
  97. #include "UDialog.h"
  98. #endif
  99.  
  100. #ifndef __UDIALOGBEHAVIOR__
  101. #include "UDialogBehavior.h"
  102. #endif
  103.  
  104. #ifndef __UVIEWSERVER__
  105. #include "UViewServer.h"
  106. #endif
  107.  
  108. #ifndef __UWINDOW__
  109. #include "UWindow.h"
  110. #endif
  111.  
  112. //ToolBox stuff
  113. //None
  114.  
  115. //ANSI stuff
  116. //None
  117.  
  118. //----------------------------------------------------------------------------------------
  119. // Constants
  120. //----------------------------------------------------------------------------------------
  121. const ResNumber kProgressIndicatorOperationStrings    = 1003;
  122. const IDType kProgressBarBehavior = 'pBar';
  123.  
  124. //----------------------------------------------------------------------------------------
  125. //  Forward and external classes
  126. //----------------------------------------------------------------------------------------
  127. class TProgressBar;            //forward
  128. class TProgressView;        //forward
  129.  
  130. //----------------------------------------------------------------------------------------
  131. // TProgressBarIndicator
  132. //----------------------------------------------------------------------------------------
  133.  
  134. class TProgressBarIndicator: public TObject
  135. {
  136.     MA_DECLARE_CLASS;
  137.     
  138. public:
  139. long fMax;
  140. long fCurrent;
  141. Boolean fStopped;
  142. TWindow* fProgressWindow;
  143. TProgressView* fProgressView;
  144. CStr255 fOperationString;
  145. CStr255 fSubjectString;
  146. long fUpdateAmount;
  147.  
  148. TProgressBarIndicator::TProgressBarIndicator();
  149. virtual ~TProgressBarIndicator();
  150.  
  151. virtual void TProgressBarIndicator::IProgressBarIndicator(const CStr255& operationString, const CStr255& subjectName);
  152. void TProgressBarIndicator::CreateProgressWindow();
  153.  
  154. virtual void TProgressBarIndicator::Continue();
  155.  
  156. virtual void TProgressBarIndicator::DoUpdate(ChangeID theChange, 
  157.                                 TObject* changedObject, TObject* changedBy,TDependencySpace* dependencySpace);
  158.                                 
  159. virtual void TProgressBarIndicator::PrepareToStart(Boolean redraw);
  160. virtual void TProgressBarIndicator::Reset();
  161. virtual void TProgressBarIndicator::Start(long max);
  162. virtual void TProgressBarIndicator::Stop();
  163. virtual Boolean TProgressBarIndicator::IsStopped();
  164. virtual void TProgressBarIndicator::DoContinue(long howMuch);
  165. virtual void TProgressBarIndicator::DrawAtOnce(Boolean wholeThing);
  166.  
  167. virtual Boolean TProgressBarIndicator::WasCancelled();
  168. long TProgressBarIndicator::GetBarLength();
  169. void TProgressBarIndicator::SetUpdateAmountTo(long updateAmount);
  170. };
  171.  
  172. //----------------------------------------------------------------------------------------
  173. // TProgressDialogBehavior
  174. //----------------------------------------------------------------------------------------
  175.  
  176. class TProgressDialogBehavior: public TDialogBehavior
  177. {
  178.     MA_DECLARE_CLASS;
  179.     
  180. public:
  181.  
  182. TProgressDialogBehavior::TProgressDialogBehavior();
  183. virtual ~TProgressDialogBehavior();
  184.  
  185. void TProgressDialogBehavior::IProgressDialogBehavior(Boolean isModal,IDType  itsDefaultItem,IDType  itsCancelItem);
  186. Boolean TProgressDialogBehavior::WasCancelled();
  187.  
  188.  
  189. };
  190.  
  191. //----------------------------------------------------------------------------------------
  192. // TProgressWindow
  193. //----------------------------------------------------------------------------------------
  194.  
  195. class TProgressWindow: public TWindow
  196. {
  197.     MA_DECLARE_CLASS;
  198.     
  199. public:
  200. TProgressWindow::TProgressWindow();
  201. virtual ~TProgressWindow();
  202.  
  203. void TProgressWindow::IProgressWindow(TDocument* itsDocument,WindowPtr itsWMgrWindow,
  204.                                           Boolean canResize,Boolean canClose,Boolean disposeOnFree);
  205.  
  206.  
  207.  
  208.  
  209. };
  210. //----------------------------------------------------------------------------------------
  211. // TProgressView
  212. //----------------------------------------------------------------------------------------
  213.  
  214. class TProgressView: public TView
  215. {
  216.     MA_DECLARE_CLASS;
  217.     
  218. public:
  219. TProgressBar* fProgressBar;
  220. TButton* fStopButton;
  221.  
  222. TProgressView::TProgressView();
  223. virtual ~TProgressView();
  224.  
  225. void TProgressView::IProgressView(TDocument* itsDocument,TView* itsSuperView,
  226.                                                                      const VPoint& itsLocation,const VPoint& itsSize,
  227.                                                                   SizeDeterminer itsHSizeDet,SizeDeterminer itsVSizeDet);
  228.  
  229. void TProgressView::Continue(long howMuch);
  230. void TProgressView::DrawAtOnce(Boolean redraw);
  231. void TProgressView::PrepareToStart(Boolean redraw);
  232. void TProgressView::Reset();
  233. void TProgressView::Start(long max);
  234. void TProgressView::Stop();
  235. long TProgressView::GetBarLength();
  236. };
  237. //----------------------------------------------------------------------------------------
  238. // TProgressBar
  239. //----------------------------------------------------------------------------------------
  240.  
  241. class TProgressBar: public TControl
  242. {
  243.     MA_DECLARE_CLASS;
  244.     
  245. public:
  246. long fMax;
  247. long fCurrent;
  248. VRect fBarRect;
  249. PenState fPen;
  250.  
  251. TProgressBar::TProgressBar();
  252. virtual ~TProgressBar();
  253. void TProgressBar::IProgressBar(TView* itsSuperView,const VPoint& itsLocation,const VPoint& itsSize,
  254.                         SizeDeterminer itsHSizeDet,SizeDeterminer itsVSizeDet,const TextStyle& itsTextStyle);
  255.  
  256. void TProgressBar::SetBarSize();
  257. void TProgressBar::SetPen();
  258. virtual void TProgressBar::Draw(const VRect& area);
  259.  
  260. void TProgressBar::Continue(long howMuch);
  261. void TProgressBar::Reset();
  262. void TProgressBar::Start(long max);
  263. void TProgressBar::Stop();
  264. long TProgressBar::GetBarLength();
  265. };
  266.  
  267. //----------------------------------------------------------------------------------------
  268. // Global initialization procedure
  269. //----------------------------------------------------------------------------------------
  270.  
  271.  
  272. extern void InitUProgressDialog();
  273. extern TProgressBarIndicator* NewProgressBarIndicator(const CStr255& itsOperationString, const CStr255& itsSubjectString);
  274.  
  275. #endif
  276.